org.springframework.web.reactive.function.client

Interface ExchangeFilterFunction

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface ExchangeFilterFunction

Represents a function that filters an exchange function.

Since:

5.0

Author:

Arjen Poutsma

Method Summary

Modifier and Type	Method and Description
default ExchangeFilterFunction	andThen(ExchangeFilterFunction after) Return a composed filter function that first applies this filter, and then applies the after filter.
default ExchangeFunction	apply(ExchangeFunction exchange) Apply this filter to the given exchange function, resulting in a filtered exchange function.
<any>	filter(ClientRequest request, ExchangeFunction next) Apply this filter to the given request and exchange function.
static ExchangeFilterFunction	ofRequestProcessor(java.util.function.Function<ClientRequest,<any>> requestProcessor) Adapt the given request processor function to a filter function that only operates on the ClientRequest.
static ExchangeFilterFunction	ofResponseProcessor(java.util.function.Function<ClientResponse,<any>> responseProcessor) Adapt the given response processor function to a filter function that only operates on the ClientResponse.

Method Detail

filter

<any> filter(ClientRequest request,
             ExchangeFunction next)

Apply this filter to the given request and exchange function.

The given exchange function represents the next entity in the chain, and can be invoked in order to proceed to the exchange, or not invoked to block the chain.

Parameters:

request - the request

next - the next exchange function in the chain

Returns:

the filtered response

andThen

default ExchangeFilterFunction andThen(ExchangeFilterFunction after)

Return a composed filter function that first applies this filter, and then applies the after filter.

Parameters:

after - the filter to apply after this filter is applied

Returns:

a composed filter that first applies this function and then applies the after function

apply

default ExchangeFunction apply(ExchangeFunction exchange)

Apply this filter to the given exchange function, resulting in a filtered exchange function.

Parameters:

exchange - the exchange function to filter

Returns:

the filtered exchange function

ofRequestProcessor

static ExchangeFilterFunction ofRequestProcessor(java.util.function.Function<ClientRequest,<any>> requestProcessor)

Adapt the given request processor function to a filter function that only operates on the ClientRequest.

Parameters:

requestProcessor - the request processor

Returns:

the filter adaptation of the request processor

ofResponseProcessor

static ExchangeFilterFunction ofResponseProcessor(java.util.function.Function<ClientResponse,<any>> responseProcessor)

Adapt the given response processor function to a filter function that only operates on the ClientResponse.

Parameters:

responseProcessor - the response processor

Returns:

the filter adaptation of the request processor